# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# For a full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# set PYTHONPATH to the src dir
import zserio

# -- Project information -----------------------------------------------------

project = "Zserio"
author = "Eccam s.r.o."
copyright = "Copyright (c) 2018-2024, Navigation Data Standard e.v."

# The release comes from the command line via -Drelease="version".
release = "unknown"
version = zserio.PYTHON_EXTENSION_RUNTIME_VERSION_STRING

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "sphinx.ext.viewcode",
    "sphinx.ext.autodoc",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = []

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# Set default role for `...` inline blocks
default_role = "code"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
html_theme_options = {
    "fixed_sidebar": False,
    "show_related": True,
    "sidebar_collapse": False,
    "sidebar_width": "340px",
}
html_copy_source = False
html_show_sphinx = False
html_sidebars = {
    "**": [
        "navigation.html",
        "localtoc.html",
        "searchbox.html",
    ]
}

# -- Extension configuration -------------------------------------------------
autoclass_content = "both"  # needed for documentation of constructors
